home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / prog / costar.arj / README.DOC < prev    next >
Text File  |  1994-01-01  |  10KB  |  236 lines
  1. -----------------------------------------------------------------
  2. C o S t a r   V1.00
  3. -----------------------------------------------------------------
  4.  
  5. (c)HI-Tech Software, 1993.   All rights reserved.
  6.  
  7.               _______
  8.          ____|__     |               (R)
  9.       --|       |    |-------------------
  10.         |   ____|__  |  Association of
  11.         |  |       |_|  Shareware
  12.         |__|   o   |    Professionals
  13.       -----|   |   |---------------------
  14.            |___|___|    MEMBER
  15.  
  16.  
  17.  
  18. HI-Tech Software
  19. 7 Century Court
  20. Montville, N.J. 07045
  21.  
  22. -----------------------------------------------------------------
  23. User's Guide
  24. -----------------------------------------------------------------
  25.  
  26. CoStar V1.00
  27.  
  28.         COBOL
  29.             Source
  30.             Translator
  31.         And
  32.             Re-engineering
  33.             tool.
  34.  
  35. CoStar is a tool designed to 'clean-up' and re-format COBOL source code.
  36. The resulting code is a properly structured and formatted module that provides:
  37.   -  Improved readability
  38.   -  Simpler logic flow determination
  39.   -  Minimized maintenance time and costs
  40.   -  Program uniformity
  41.  
  42. Re-formatting (paging, spacing, and indentation) yields increased program
  43. clarity.  Time spent analyzing source code is dramatically reduced through
  44. the use of numeric prefixes on paragraph names, proper verb clause indentation,
  45. and uniform level numbering of data variables.  Confusion is minimized by the
  46. removal of excess spaces and punctuation and the inclusion of spaces and
  47. parentheses where they should be.
  48.  
  49. Input to CoStar:
  50. CoStar requires only a cleanly compiled COBOL source module as input.
  51. Optional parameters allow the programmer to:
  52.   -  Re-sequence source in columns 1 - 6
  53.   -  Re-number the paragraph names
  54.   -  Place a constant in columns 73 - 80
  55.   -  Print a listing of the processed code
  56.   -  Select APOST or QUOTE as default
  57.  
  58. Output of CoStar:
  59. CoStar produces a source module that is logically identical to the input
  60. but in a fresh, properly indented and organized format.
  61.  
  62.  
  63. What CoStar will do:
  64.  
  65. ID DIVISION thru WORKING-STORAGE
  66.   -  Re-formats and aligns all areas to appropriate margins
  67.   -  Resets level numbers to 01, 05, 10 etc.
  68.   -  Aligns all Picture clauses
  69.   -  Abbreviates reserved words where possible (COMPUTATIONAL to COMP)
  70.   -  Re-aligns all literals in Value clause
  71.  
  72. PROCEDURE DIVISION
  73.   -  All COBOL verbs, including those in the Communications and Report Writer
  74.      sections and both CICS command and macro levels, are recognized and
  75.      and re-organized into an easily understood structured format
  76.   -  Paragraph names may be re-numbered with a four digit number; start number
  77.      and increment are optional
  78.   -  IF, ELSE, PERFORM, END-IF, END-PERFORM and all other verbs are properly
  79.      aligned and indented
  80.   -  Conditional arguments are re-formatted one argument to a line
  81.   -  Verbs are formatted one to a line
  82.   -  NOTE statements are changed to comments to avoid the inherent confusion
  83.      generated by the NOTE
  84.   -  Relational operators (EQUAL, LESS, GREATER) are changed to their
  85.      mathematical equivalants (=, <, >)
  86.  
  87. All DIVISIONS:
  88.   -  Precede each DIVISION and paragraph with a comment line:
  89.          *++++++++++...
  90.   -  Surplus spaces and commas are removed
  91.  
  92. -----------------------------------------------------------
  93. How to contact me
  94. -----------------------------------------------------------
  95.  Comments and suggestions (and reports of problems) would be greatly
  96.  appreciated.
  97.  
  98.    Harry W. Ilaria
  99.    HI-Tech Software
  100.    7 Century Court
  101.    Montville N.J. 07045
  102.  
  103. -----------------------------------------------------------
  104. How to pay for/register CoStar
  105. -----------------------------------------------------------
  106.  
  107.  CoStar V1.00 is ShareWare.
  108.  
  109.  You may make copies of this program and give them to others for
  110.  evaluation as long as the documentation is provided with the
  111.  program, both unaltered.
  112.  
  113.  If you make use of CoStar you are expected to pay a registration
  114.  fee of $20.00.  Registered users will receive the latest version of
  115.  CoStar.
  116.  
  117.  See "INVOICE.DOC" for an easily printed invoice.
  118.  
  119.  You may register by credit card from PsL at 1-800-2424-PsL.
  120.  The Order # is 11162.
  121.  
  122.  You may also register this software thru CompuServe.
  123.  "GO SWREG" for simple instructions. The Registration ID is 2094
  124.  
  125. -----------------------------------------------------------
  126. DEFINITION OF SHAREWARE
  127. -----------------------------------------------------------
  128.  
  129. Shareware distribution gives users a chance to try software
  130. before buying it. If you try a Shareware program and continue
  131. using it, you are expected to register. Individual programs
  132. differ on details -- some request registration while others
  133. require it, some specify a maximum trial period. With
  134. registration, you get anything from the simple right to continue
  135. using the software to an updated program with printed manual.
  136.  
  137. Copyright laws apply to both Shareware and commercial software,
  138. and the copyright holder retains all rights, with a few specific
  139. exceptions as stated below. Shareware authors are accomplished
  140. programmers, just like commercial authors, and the programs are
  141. of comparable quality. (In both cases, there are good programs
  142. and bad ones!) The main difference is in the method of
  143. distribution. The author specifically grants the right to copy
  144. and distribute the software, either to all and sundry or to a
  145. specific group. For example, some authors require written
  146. permission before a commercial disk vendor may copy their
  147. Shareware.
  148.  
  149. Shareware is a distribution method, not a type of software. You
  150. should find software that suits your needs and pocketbook,
  151. whether it's commercial or Shareware. The Shareware system makes
  152. fitting your needs easier, because you can try before you buy.
  153. And because the overhead is low, prices are low also. Shareware
  154. has the ultimate money-back guarantee -- if you don't use the
  155. product, you don't pay for it.
  156.  
  157. -----------------------------------------------------------
  158. DISCLAIMER - AGREEMENT
  159. -----------------------------------------------------------
  160.  
  161. Users of CoStar V1.00 must accept this disclaimer of warranty:
  162. "CoStar V1.00 is supplied as is. The author disclaims all
  163. warranties, expressed or implied, including, without limitation,
  164. the warranties of merchantability and of fitness for any purpose.
  165. The author assumes no liability for damages, direct or conse-
  166. quential, which may result from the use of CoStar V1.00."
  167.  
  168. CoStar V1.00 is a "shareware program" and is provided at no
  169. charge to the user for evaluation.  Feel free to share it with your
  170. friends, but please do not give it away altered or as part of
  171. another system.  The essence of "user-supported" software is to
  172. provide personal computer users with quality software without
  173. high prices, and yet to provide incentive for programmers to
  174. continue to develop new products.  If you find this program
  175. useful and find that you are using CoStar V1.00 and continue to
  176. use CoStar V1.00 after a reasonable trial period, you must make a
  177. registration payment of $20.00 plus $2.00 S&H to HI-Tech Software.
  178. The $20.00 registration fee will license one copy for use on any one
  179. computer at any one time.  You must treat this software just like
  180. a book.  An example is that this software may be used by any
  181. number of people and may be freely moved from one computer
  182. location to another, so long as there is no possibility of it
  183. being used at one location while it's being used at another.
  184. Just as a book cannot be read by two different persons at the
  185. same time.
  186.  
  187. Commercial users of CoStar V1.00 must register and pay for their
  188. copies of CoStar V1.00 within 30 days of first use or their
  189. licence is withdrawn.  Site-License arrangements may be made by con-
  190. tacting HI-Tech Software.
  191.  
  192. Anyone distributing CoStar V1.00 for any kind of remuneration must
  193. first contact HI-Tech Software at the address below for authorization.
  194. This authorization will be automatically granted to distributors
  195. recognized by the (ASP) as adhering to its guidelines for
  196. shareware distributors, and such distributors may begin offering
  197. CoStar V1.00 immediately (However HI-Tech Software must still be
  198. advised so that the distributor can be kept up-to-date with the latest
  199. version of CoStar V1.00.
  200.  
  201. You are encouraged to pass a copy of CoStar V1.00 along to your
  202. friends for evaluation.  Please encourage them to register their
  203. copy if they find that they can use it.  All registered users
  204. will receive a copy of the latest version of the CoStar V1.00
  205. system and 90 days free support.
  206.  
  207.  
  208. -----------------------------------------------------------
  209. OMBUDSMAN
  210. -----------------------------------------------------------
  211.  
  212.   "HI-Tech Software is a member of the Association of Shareware
  213.   Professionals (ASP).  ASP wants to make sure that the shareware
  214.   principle works for you. If you are unable to resolve a
  215.   shareware-related problem with an ASP member by contacting the member
  216.   directly, ASP may be able to help. The ASP Ombudsman can help you
  217.   resolve a dispute or problem with an ASP member, but does not provide
  218.   technical support for members' products.    Please write to the ASP
  219.   Ombudsman at 545 Grover Road, Muskegon, MI 49442-9427 USA, FAX
  220.   616-788-2765 or send a CompuServe message via CompuServe Mail to
  221.   ASP Ombudsman 70007,3536."
  222.  
  223.  
  224. -----------------------------------------------------------
  225. UNIVERSAL INSTALL
  226. -----------------------------------------------------------
  227.  
  228. The installation program used to install CoStar is called
  229. "UNIVERSAL INSTALL". This excellent program is available from:
  230.  
  231.                 The GoodSoft Company
  232.                 1630 30th Street
  233.                 Suite 235
  234.                 Boulder, CO  80301
  235.  
  236.